Vcenter Host CreateSpec

Vcenter Host CreateSpec
Vcenter Host CreateSpec

The Vcenter Host CreateSpec schema defines the information used to create a host.

JSON Example
{
    "hostname": "string",
    "port": 0,
    "user_name": "string",
    "password": "string",
    "folder": "string",
    "thumbprint_verification": "string",
    "thumbprint": "string",
    "ssl_certificate": "string",
    "force_add": false
}
string
hostname
Required

The IP address or DNS resolvable name of the host.

integer As int64 As int64
port
Optional

The port of the host.

If missing or null, port 443 will be used.

string
user_name
Required

The administrator account on the host.

string As password As password
password
Required

The password for the administrator account on the host.

string
folder
Optional

Host and cluster folder in which the new standalone host should be created.

This property is currently required. In the future, if this property is missing or null, the system will attempt to choose a suitable folder for the host; if a folder cannot be chosen, the host creation operation will fail.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.

string
thumbprint_verification
Required

Type of host's SSL certificate verification to be done.

For more information see: Vcenter Host CreateSpec ThumbprintVerification.

string
thumbprint
Optional

The thumbprint of the SSL certificate, which the host is expected to have. The thumbprint is always computed using the SHA1 hash and is the string representation of that hash in the format: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx where, 'x' represents a hexadecimal digit.

This property is optional and it is only relevant when the value of thumbprint_verification is Vcenter Host CreateSpec ThumbprintVerification.THUMBPRINT.

string
ssl_certificate
Optional

The SSL certificate in PEM format, which the host is expected to have.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of thumbprint_verification is Vcenter Host CreateSpec ThumbprintVerification.CERTIFICATE.

boolean
force_add
Optional

Whether host should be added to the vCenter Server even if it is being managed by another vCenter Server. The original vCenterServer loses connection to the host.

If missing or null, forceAdd is default to false.

Parameter To